Replace `<literal>` nodes with `<constant>` for constants by phansys · Pull Request #2310 · php/doc-en

phansys · 2023-02-18T12:19:07Z

172 occurrences were replaced from <literal>([A-Za-z0-9_]+)::([A-Z0-9_\*]+)</literal> to <constant>$1::$2</constant>.

See #2306 (comment).

TODO:

Wait for Mark up unspecific constants as replaceable #1963.

Girgias

Thanks for tackling this, this makes sense.

However, I'd wait a bit to check with translations as this does do some busy work for them (and as I'm being on the French translation and the constant tag does not generates links it would be nice that I can tackle more urgent stuff)

Girgias · 2023-02-20T16:20:30Z

It would make sense to coordinate this with #1963 also to not repeat the work multiple times.

phansys · 2023-02-20T16:30:54Z

Great! Let me inherit these changes here and mark the other PR in a TO-DO list in order to make the dependency explicit.

Girgias

Overall OK but I'm going to wait to merge this as this is a QA change.

Also it would be nice to fix the whitespaces in another PR that one can skip-revcheck as those clutter the PR.

phansys · 2023-08-31T10:16:04Z

Also it would be nice to fix the whitespaces in another PR that one can skip-revcheck as those clutter the PR.

Whitespace changes were reverted 👍

Girgias · 2024-04-17T12:03:34Z

Sorry for the delay in this, could you rebase the PR on master?

phansys · 2024-04-17T13:40:45Z

Rebased.

haszi · 2024-04-17T14:01:34Z

There are a few constants with replaceable parts that use _XXX instead of _*. Do you think it would make sense to add those to this PR?

These are the ones I've found in doc-en:

CURL_VERSION_XXX
CURLM_XXX
CURLOPT_XXX
IMAGETYPE_XXX
PNG_FILTER_XXX
SOAP_PERSISTENCE_XXX
TIDY_TAG_XXX
VT_XXX

phansys · 2024-04-17T14:18:19Z

I think these are missing cases @haszi. Thank you for pointing.
Let me check if I can find a consistent way to catch them and I'll update the PR.

phansys · 2024-04-17T14:54:03Z

The cases using the _XXX suffix were addressed.

Girgias

Not sure the runkit changes are appropriate, nor the Enumeration docs as those refer to inline examples, maybe using code is more appropriate but I need to have a think about this.

Copilot

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

kamil-tekiela · 2026-09-24T23:17:55Z

You can drop the changes to the migrated extensions. It will make reviewing this easier too.

kamil-tekiela · 2026-09-24T23:26:58Z

   The only limitation is that the <literal>class</literal> keyword still
   cannot be used as a constant name, otherwise it would conflict with the
-   class name resolution syntax (<literal>ClassName::class</literal>).
+   class name resolution syntax (<constant>ClassName::class</constant>).


This is not a constant. It shuld stay as literal.

doc-en/language/oop5/constants.xml

Lines 64 to 68 in d4f96da

<para>

The special <constant>::class</constant> constant allows

for fully qualified class name resolution at compile time,

this is useful for namespaced classes:

</para>

Fair enough, it is also called a magic constant here https://www.php.net/manual/en/language.constants.magic.php

However, I don't think we are going for semantics here. The change is about making the constants link up properly, and magic "constant" ::class cannot do that. So, using <constant> is not useful here. Compare how it is rendered right now on https://www.php.net/manual/en/migration70.other-changes.php or https://www.php.net/manual/en/language.oop5.basic.php#language.oop5.basic.class.class

kamil-tekiela · 2026-09-24T23:27:21Z

    name resolution.
    To obtain the fully qualified name of a class <literal>ClassName</literal>
-    use <literal>ClassName::class</literal>. This is particularly useful with
+    use <constant>ClassName::class</constant>. This is particularly useful with


kamil-tekiela · 2026-09-24T23:27:54Z

    This declaration creates a new enumerated type named <literal>Suit</literal>, which has
-    four and only four legal values: <literal>Suit::Hearts</literal>, <literal>Suit::Diamonds</literal>,
-    <literal>Suit::Clubs</literal>, and <literal>Suit::Spades</literal>. Variables may be assigned
+    four and only four legal values: <constant>Suit::Hearts</constant>, <constant>Suit::Diamonds</constant>,


I don't think these are constants.

kamil-tekiela · 2026-09-24T23:28:09Z

     The <literal>query()</literal> function can now proceed safe in the knowledge that
-     <literal>$order</literal> is guaranteed to be either <literal>SortOrder::Asc</literal>
-     or <literal>SortOrder::Desc</literal>. Any other value would have resulted in a
+     <literal>$order</literal> is guaranteed to be either <constant>SortOrder::Asc</constant>


kamil-tekiela · 2026-09-24T23:29:34Z

  &reftitle.returnvalues;
  <para>
-   Returns an <literal>IntlChar::PROPERTY_</literal> constant value,
+   Returns an <constant>IntlChar::PROPERTY_</constant> constant value,


I think you are missing replaceable here.

phansys marked this pull request as ready for review February 18, 2023 12:19

phansys force-pushed the constants branch from 24457bf to a434cb2 Compare February 18, 2023 12:26

Girgias reviewed Feb 18, 2023

View reviewed changes

phansys mentioned this pull request Feb 19, 2023

Replace <literal> nodes with <constant> for constants php/doc-es#56

Merged

phansys force-pushed the constants branch from a434cb2 to 1a131a8 Compare February 20, 2023 16:27

phansys force-pushed the constants branch 2 times, most recently from b950b26 to bae3592 Compare February 20, 2023 16:58

phansys requested a review from Girgias February 20, 2023 19:01

Girgias added the QA Quality Assurance label Mar 9, 2023

phansys force-pushed the constants branch from bae3592 to 329bd9c Compare March 15, 2023 01:46

phansys force-pushed the constants branch 2 times, most recently from b8da203 to 21eb6eb Compare August 25, 2023 02:36

Girgias approved these changes Aug 30, 2023

View reviewed changes

Girgias added this to the QA improvements milestone Aug 30, 2023

phansys force-pushed the constants branch from 21eb6eb to b095048 Compare August 31, 2023 10:14

phansys force-pushed the constants branch from b095048 to 9ca1b51 Compare August 31, 2023 10:23

phansys force-pushed the constants branch from 9ca1b51 to 50989b9 Compare April 17, 2024 13:38

phansys requested review from TimWolla, kamil-tekiela and ndossche as code owners April 17, 2024 13:38

phansys force-pushed the constants branch from 50989b9 to 8c56baf Compare April 17, 2024 13:39

phansys force-pushed the constants branch from 8c56baf to 83de332 Compare April 17, 2024 13:46

phansys force-pushed the constants branch from 83de332 to c81db62 Compare April 17, 2024 14:52

phansys force-pushed the constants branch from c81db62 to 5240032 Compare April 17, 2024 15:31

Girgias reviewed Apr 20, 2024

View reviewed changes

Copilot AI lite review requested due to automatic review settings September 24, 2026 23:08

phansys force-pushed the constants branch from 5240032 to 214b123 Compare September 24, 2026 23:08

Copilot AI reviewed Sep 24, 2026

phansys force-pushed the constants branch from 214b123 to 88603a2 Compare September 24, 2026 23:23

kamil-tekiela requested changes Sep 24, 2026

View reviewed changes

phansys force-pushed the constants branch from 88603a2 to dfc5dc9 Compare September 25, 2026 01:04

Replace <literal> nodes with <constant> for constants

1132170

phansys force-pushed the constants branch from dfc5dc9 to 1132170 Compare September 25, 2026 02:18

phansys requested a review from kamil-tekiela September 25, 2026 09:22

kamil-tekiela approved these changes Sep 25, 2026

View reviewed changes

kamil-tekiela merged commit 9c73659 into php:master Sep 25, 2026
2 of 3 checks passed

phansys deleted the constants branch September 25, 2026 10:41

	<para>
	The special <constant>::class</constant> constant allows
	for fully qualified class name resolution at compile time,
	this is useful for namespaced classes:
	</para>

Conversation

phansys commented Feb 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Girgias left a comment

Choose a reason for hiding this comment

Uh oh!

Girgias commented Feb 20, 2023

Uh oh!

phansys commented Feb 20, 2023

Uh oh!

Girgias left a comment

Choose a reason for hiding this comment

Uh oh!

phansys commented Aug 31, 2023

Uh oh!

Girgias commented Apr 17, 2024

Uh oh!

phansys commented Apr 17, 2024

Uh oh!

haszi commented Apr 17, 2024

Uh oh!

phansys commented Apr 17, 2024

Uh oh!

phansys commented Apr 17, 2024

Uh oh!

Girgias left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

kamil-tekiela commented Sep 24, 2026

Uh oh!

kamil-tekiela Sep 24, 2026

Choose a reason for hiding this comment

Uh oh!

phansys Sep 25, 2026

Choose a reason for hiding this comment

Uh oh!

kamil-tekiela Sep 25, 2026

Choose a reason for hiding this comment

Uh oh!

kamil-tekiela Sep 24, 2026

Choose a reason for hiding this comment

Uh oh!

kamil-tekiela Sep 24, 2026

Choose a reason for hiding this comment

Uh oh!

kamil-tekiela Sep 24, 2026

Choose a reason for hiding this comment

Uh oh!

kamil-tekiela Sep 24, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

phansys commented Feb 18, 2023 •

edited

Loading